Skip to main content

​
Introduction

Create personalized avatar videos using custom photo avatars generated from your own portrait photos. Perfect for branded content, personal messaging, or using specific talent.

​
Key Features

Your Own Face

Use your own photo to create custom avatars

Brand Consistency

Maintain consistent personal or brand presence

Multi-Language

Same face across 40+ languages

Professional Quality

High-quality avatar generation from photos
Prerequisites: You must first create a photo avatar before using it in videos. See [Create Photo Avatar](/api-reference/v2/API Documentation/CreatePhotoAvatar) guide.

​
Quick Start

EndpointPurposeDocumentation
GET /avatars/photo_avatarsGet your photo avatarsAPI Reference
POST /create_video_from_avatarCreate video with photo avatarAPI Reference
GET /avatar_video/{id}Check video statusAPI Reference

​
Key Parameters

ParameterTypeRequiredDescription
avatar.avatar_idinteger✅Your photo avatar ID
avatar.avatar_typeinteger✅Must be 1 for photo avatars
voice.typestring✅“script” for text-to-speech
voice.voice_idstring✅Voice ID for text-to-speech
voice.scriptstring✅Text for avatar to speak
aspect_ratiostring✅portrait/landscape/square
screen_styleinteger✅1=Full screen, 2=Split screen, 3=Picture in picture
Important: Set avatar.avatar_type: 1 to use photo avatars. Using 0 will use public avatars instead.

​
Code Examples

​
Step 1: Create Video with Photo Avatar

Get your photo avatar ID first: 
curl --request GET \
  --url 'https://api.jogg.ai/v2/avatars/photo_avatars' \
  --header 'x-api-key: YOUR_API_KEY'
Response: 
{
  "code": 0,
  "msg": "Success",
  "data": {
    "avatars": [
      {
        "id": 123,
        "name": "My Custom Avatar",
        "status": 1,
        "cover_url": "https://res.jogg.ai/avatars/cover_123.jpg"
      }
    ]
  }
}
Then create video with the photo avatar: 
curl --request POST \
  --url 'https://api.jogg.ai/v2/create_video_from_avatar' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "avatar": {
      "avatar_id": 123,
      "avatar_type": 1
    },
    "voice": {
      "type": "script",
      "voice_id": "en-US-ChristopherNeural",
      "script": "Hello! This is my custom photo avatar speaking."
    },
    "aspect_ratio": "portrait",
    "screen_style": 1,
    "caption": true
  }'
Response: 
{
  "code": 0,
  "msg": "Success",
  "data": {
    "video_id": "video_123456"
  }
}
Ensure photo avatar status is 1 (completed) before creating videos. Status 0 means still processing.

​
Step 2: Check Video Status

Poll to check if video is ready: 
curl --request GET \
  --url 'https://api.jogg.ai/v2/avatar_video/video_123456' \
  --header 'x-api-key: YOUR_API_KEY'
Response (Processing): 
{
  "code": 0,
  "msg": "Success",
  "data": {
    "video_id": "video_123456",
    "status": "processing",
    "created_at": 1732806631
  }
}
Response (Completed): 
{
  "code": 0,
  "msg": "Success",
  "data": {
    "video_id": "video_123456",
    "status": "completed",
    "video_url": "https://res.jogg.ai/videos/video_123456.mp4",
    "cover_url": "https://res.jogg.ai/covers/cover_123456.jpg",
    "created_at": 1732806631
  }
}
Instead of polling, use [Webhooks](/api-reference/v2/API Documentation/WebhookIntegration) to get notified instantly when videos are ready!

​
Use Case Examples

Use your own face in videos:
  • Create photo avatar from your photo
  • Generate branded video content
  • Consistent personal presence across platforms
  • Scale your personal brand without being on camera
Feature company executives or talent:
  • Create avatar from CEO or spokesperson photo
  • Generate company announcements and updates
  • Consistent company voice and appearance
  • Reduce production time and costs
Speak in languages you don’t know:
  • Create avatar from your photo once
  • Generate videos in 40+ languages
  • Maintain your face across all languages
  • Reach global audiences authentically
Scale your content creation:
  • Use your photo avatar for multiple videos
  • Create content in different languages
  • Maintain your personal brand
  • Save time on video production

​
Tips for Best Results

Photo Avatar Quality:
  • Use high-quality source photos (1920x1080 or higher)
  • Ensure good lighting in source photo
  • Face should be clearly visible
  • Check avatar status is 1 (completed) before use
  • Test with short script first
Script Recommendations:
  • Keep scripts natural and conversational
  • Avoid very long scripts (< 2 minutes)
  • Test pronunciation of special terms
  • Use appropriate voice for avatar personality

Create Photo Avatar

Generate photo avatars from your photos

Get Photo Avatars

List your photo avatars

Get Avatar Video

Check video generation status

Get Voices

Browse available voices